home *** CD-ROM | disk | FTP | other *** search
/ Aminet 15 / Aminet 15 - Nov 1996.iso / Aminet / dev / gcc / ixemsdk.lha / man / cat3 / glob.0 < prev    next >
Text File  |  1996-09-02  |  11KB  |  212 lines
  1.  
  2. GLOB(3)                    UNIX Programmer's Manual                    GLOB(3)
  3.  
  4. NNAAMMEE
  5.      gglloobb, gglloobbffrreeee - generate pathnames matching a pattern
  6.  
  7. SSYYNNOOPPSSIISS
  8.      ##iinncclluuddee <<gglloobb..hh>>
  9.  
  10.      _i_n_t
  11.      gglloobb(_c_o_n_s_t _c_h_a_r _*_p_a_t_t_e_r_n, _i_n_t _f_l_a_g_s,
  12.              _c_o_n_s_t _i_n_t _(_*_e_r_r_f_u_n_c_)_(_c_o_n_s_t _c_h_a_r _*_, _i_n_t_), _g_l_o_b___t _*_p_g_l_o_b)
  13.  
  14.      _v_o_i_d
  15.      gglloobbffrreeee(_g_l_o_b___t _*_p_g_l_o_b)
  16.  
  17. DDEESSCCRRIIPPTTIIOONN
  18.      The gglloobb() function is a pathname generator that implements the rules for
  19.      file name pattern matching used by the shell.
  20.  
  21.      The include file _g_l_o_b_._h defines the structure type _g_l_o_b___t, which contains
  22.      at least the following fields:
  23.  
  24.      typedef struct {
  25.              int gl_pathc;           /* count of total paths so far */
  26.              int gl_matchc;          /* count of paths matching pattern */
  27.              int gl_offs;            /* reserved at beginning of gl_pathv */
  28.              int gl_flags;           /* returned flags */
  29.              char **gl_pathv;        /* list of paths matching pattern */
  30.      } glob_t;
  31.  
  32.      The argument _p_a_t_t_e_r_n is a pointer to a pathname pattern to be expanded.
  33.      The gglloobb() argument matches all accessible pathnames against the pattern
  34.      and creates a list of the pathnames that match.  In order to have access
  35.      to a pathname, gglloobb() requires search permission on every component of a
  36.      path except the last and read permission on each directory of any file-
  37.      name component of _p_a_t_t_e_r_n that contains any of the special characters
  38.      `*', `?' or `['.
  39.  
  40.      The gglloobb() argument stores the number of matched pathnames into the
  41.      _g_l___p_a_t_h_c field, and a pointer to a list of pointers to pathnames into the
  42.      _g_l___p_a_t_h_v field.  The first pointer after the last pathname is NULL. If
  43.      the pattern does not match any pathnames, the returned number of matched
  44.      paths is set to zero.
  45.  
  46.      It is the caller's responsibility to create the structure pointed to by
  47.      _p_g_l_o_b. The gglloobb() function allocates other space as needed, including the
  48.      memory pointed to by _g_l___p_a_t_h_v.
  49.  
  50.      The argument _f_l_a_g_s is used to modify the behavior of gglloobb().  The value
  51.      of _f_l_a_g_s is the bitwise inclusive OR of any of the following values de-
  52.      fined in _g_l_o_b_._h:
  53.  
  54.      GLOB_APPEND      Append pathnames generated to the ones from a previous
  55.                       call (or calls) to gglloobb().  The value of _g_l___p_a_t_h_c will
  56.                       be the total matches found by this call and the previous
  57.                       call(s).  The pathnames are appended to, not merged with
  58.                       the pathnames returned by the previous call(s).  Between
  59.                       calls, the caller must not change the setting of the
  60.                       GLOB_DOOFFS flag, nor change the value of _g_l___o_f_f_s when
  61.                       GLOB_DOOFFS is set, nor (obviously) call gglloobbffrreeee() for
  62.                       _p_g_l_o_b.
  63.  
  64.      GLOB_DOOFFS      Make use of the _g_l___o_f_f_s field.  If this flag is set,
  65.                       _g_l___o_f_f_s is used to specify how many NULL pointers to
  66.                       prepend to the beginning of the _g_l___p_a_t_h_v field.  In oth-
  67.                       er words, _g_l___p_a_t_h_v will point to _g_l___o_f_f_s NULL pointers,
  68.                       followed by _g_l___p_a_t_h_c pathname pointers, followed by a
  69.                       NULL pointer.
  70.  
  71.      GLOB_ERR         Causes gglloobb() to return when it encounters a directory
  72.                       that it cannot open or read.  Ordinarily, gglloobb() contin-
  73.                       ues to find matches.
  74.  
  75.      GLOB_MARK        Each pathname that is a directory that matches _p_a_t_t_e_r_n
  76.                       has a slash appended.
  77.  
  78.      GLOB_NOCHECK     If _p_a_t_t_e_r_n does not match any pathname, then gglloobb() re-
  79.                       turns a list consisting of only _p_a_t_t_e_r_n, with the number
  80.                       of total pathnames is set to 1, and the number of
  81.                       matched pathnames set to 0.  If GLOB_QUOTE is set, its
  82.                       effect is present in the pattern returned.
  83.  
  84.      GLOB_NOSORT      By default, the pathnames are sorted in ascending ASCII
  85.                       order; this flag prevents that sorting (speeding up
  86.                       gglloobb()).
  87.  
  88.      The following values may also be included in _f_l_a_g_s, however, they are
  89.      non-standard extensions to IEEE Std1003.2 (``POSIX'').
  90.  
  91.      GLOB_ALTDIRFUNC  The following additional fields in the pglob structure
  92.                       have been initialized with alternate functions for glob
  93.                       to use to open, read, and close directories and to get
  94.                       stat information on names found in those directories.
  95.  
  96.                               void *(*gl_opendir)(const char * name);
  97.                               struct dirent *(*gl_readdir)(void *);
  98.                               void (*gl_closedir)(void *);
  99.                               int (*gl_lstat)(const char *name, struct stat *st);
  100.                               int (*gl_stat)(const char *name, struct stat *st);
  101.  
  102.                       This extension is provided to allow programs such as re-
  103.                       store(8) to provide globbing from directories stored on
  104.                       tape.
  105.  
  106.      GLOB_BRACE       Pre-process the pattern string to expand `{pat,pat,...}'
  107.                       strings like csh(1.)The pattern  `{}' is left unexpanded
  108.                       for historical reasons (Csh(1) does the same thing to
  109.                       ease typing of find(1) patterns).
  110.  
  111.      GLOB_MAGCHAR     Set by the gglloobb() function if the pattern included glob-
  112.                       bing characters.  See the description of the usage of
  113.                       the _g_l___m_a_t_c_h_c structure member for more details.
  114.  
  115.      GLOB_NOMAGIC     Is the same as GLOB_NOCHECK but it only appends the
  116.                       _p_a_t_t_e_r_n if it does not contain any of the special char-
  117.                       acters ``*'', ``?'' or ``[''.  GLOB_NOMAGIC is provided
  118.                       to simplify implementing the historic csh(1) globbing
  119.                       behavior and should probably not be used anywhere else.
  120.  
  121.      GLOB_QUOTE       Use the backslash (`\') character for quoting: every oc-
  122.                       currence of a backslash followed by a character in the
  123.                       pattern is replaced by that character, avoiding any spe-
  124.                       cial interpretation of the character.
  125.  
  126.      GLOB_TILDE       Expand patterns that start with `~' to user name home
  127.                       directories.
  128.  
  129.      If, during the search, a directory is encountered that cannot be opened
  130.      or read and _e_r_r_f_u_n_c is non-NULL, gglloobb() calls _(_*_e_r_r_f_u_n_c_)_(_p_a_t_h_, _e_r_r_n_o_).
  131.      This may be unintuitive: a pattern like `*/Makefile' will try to stat(2)
  132.      `foo/Makefile' even if `foo' is not a directory, resulting in a call to
  133.      _e_r_r_f_u_n_c. The error routine can suppress this action by testing for ENOENT
  134.      and ENOTDIR; however, the GLOB_ERR flag will still cause an immediate re-
  135.      turn when this happens.
  136.  
  137.      If _e_r_r_f_u_n_c returns non-zero, gglloobb() stops the scan and returns GLOB_ABEND
  138.      after setting _g_l___p_a_t_h_c and _g_l___p_a_t_h_v to reflect any paths already matched.
  139.      This also happens if an error is encountered and GLOB_ERR is set in
  140.      _f_l_a_g_s, regardless of the return value of _e_r_r_f_u_n_c, if called.  If GLOB_ERR
  141.      is not set and either _e_r_r_f_u_n_c is NULL or _e_r_r_f_u_n_c returns zero, the error
  142.      is ignored.
  143.  
  144.      The gglloobbffrreeee() function frees any space associated with _p_g_l_o_b from a pre-
  145.      vious call(s) to gglloobb().
  146.  
  147. RREETTUURRNN VVAALLUUEESS
  148.      On successful completion, gglloobb() returns zero.  In addition the fields of
  149.      _p_g_l_o_b contain the values described below:
  150.  
  151.      _g_l___p_a_t_h_c      contains the total number of matched pathnames so far.
  152.                    This includes other matches from previous invocations of
  153.                    gglloobb() if GLOB_APPEND was specified.
  154.  
  155.      _g_l___m_a_t_c_h_c     contains the number of matched pathnames in the current in-
  156.                    vocation of gglloobb().
  157.  
  158.      _g_l___f_l_a_g_s      contains a copy of the _f_l_a_g_s parameter with the bit
  159.                    GLOB_MAGCHAR set if _p_a_t_t_e_r_n contained any of the special
  160.                    characters ``*'', ``?'' or ``['', cleared if not.
  161.  
  162.      _g_l___p_a_t_h_v      contains a pointer to a NULL-terminated list of matched
  163.                    pathnames.  However, if _g_l___p_a_t_h_c is zero, the contents of
  164.                    _g_l___p_a_t_h_v are undefined.
  165.  
  166.      If gglloobb() terminates due to an error, it sets _e_r_r_n_o and returns one of
  167.      the following non-zero constants, which are defined in the include file
  168.      <_g_l_o_b_._h>:
  169.  
  170.      GLOB_NOSPACE  An attempt to allocate memory failed.
  171.  
  172.      GLOB_ABEND    The scan was stopped because an error was encountered and
  173.                    either GLOB_ERR was set or _(_*_e_r_r_f_u_n_c_)_(_) returned non-zero.
  174.  
  175.      The arguments _p_g_l_o_b_-_>_g_l___p_a_t_h_c and _p_g_l_o_b_-_>_g_l___p_a_t_h_v are still set as speci-
  176.      fied above.
  177.  
  178. EEXXAAMMPPLLEE
  179.      A rough equivalent of `ls -l *.c *.h' can be obtained with the following
  180.      code:
  181.  
  182.            glob_t g;
  183.  
  184.            g.gl_offs = 2;
  185.            glob("*.c", GLOB_DOOFFS, NULL, &g);
  186.            glob("*.h", GLOB_DOOFFS | GLOB_APPEND, NULL, &g);
  187.            g.gl_pathv[0] = "ls";
  188.            g.gl_pathv[1] = "-l";
  189.            execvp("ls", g.gl_pathv);
  190.  
  191. SSEEEE AALLSSOO
  192.      sh(1),  fnmatch(3),  regexp(3)
  193.  
  194. SSTTAANNDDAARRDDSS
  195.      The gglloobb() function is expected to be IEEE Std1003.2 (``POSIX'') compati-
  196.      ble with the exception that the flags GLOB_ALTDIRFUNC, GLOB_BRACE
  197.      GLOB_MAGCHAR, GLOB_NOMAGIC, GLOB_QUOTE, and GLOB_TILDE, and the fields
  198.      _g_l___m_a_t_c_h_c and _g_l___f_l_a_g_s should not be used by applications striving for
  199.      strict POSIX conformance.
  200.  
  201. HHIISSTTOORRYY
  202.      The gglloobb() and gglloobbffrreeee() functions first appeared in 4.4BSD.
  203.  
  204. BBUUGGSS
  205.      Patterns longer than MAXPATHLEN may cause unchecked errors.
  206.  
  207.      The gglloobb() function may fail and set _e_r_r_n_o for any of the errors speci-
  208.      fied for the library routines stat(2),  closedir(3),  opendir(3),
  209.      readdir(3),  malloc(3),  and free(3).
  210.  
  211. BSD Experimental                April 16, 1994                               4
  212.